System UDCs facilitate system-level supervision of specific data points. The UDCs listed here are classified topically and include descriptions, keywords, and function.
For example, you could create a point record in the Point Service (PNT) that includes the UDC SYCSSTP. SYCSSTP would then send a notification if the percentage of successful messages on a serial radio communication device dropped below 95%.
See the following subsections for more information:
For general information about system UDCs, see System UDCs.
Many of the UDCs listed here can include a suffix that constrains the amount of data collected by the UDC. The constraint is time based. You could append any of these values to the end of the UDC to provide such a constraint: 2M, CD, CH, CM, LD, LH, LM, where 2M means 20 minutes, CD means current day, CH means current hour, CM means current month, LD means last day, LH means last hour, and LM means last month.
The following UDCs provide system-level information.
The following UDCs provide system-level information.
The following UDCs provide system-level information.
The following UDCs provide system-level information.
The following UDCs provide system-level information.
The following UDCs provide system-level information.
The following UDCs provide system-level information.
The following UDCs provide system-level information.
The following UDCs provide system-level information.
| UDC Description | UDC | UI Description | Description | Point Type |
|---|---|---|---|---|
|
Avg Resp Proc. Time |
SYMSARPT |
The average number of milliseconds to process an item in the processing queue. |
Analog Input |
|
|
Avg Ttl Mess Proc. Time |
SYMSATMT |
The average number of milliseconds to process all items in the processing queue. |
Analog Input |
|
|
Pending Comm Queue Cnt |
SYCSPEND |
The number of messages pending in a communication queue. |
Analog Input |
|
|
Pending Comm Queue Cnt per Remote Device |
SYRSPEND |
The number of messages the specified remote device has pending in its associated communication queue. |
Analog Input |
|
|
Point Value Only Resp Queue |
SYPROCQPT |
Represents the size of the Point processing queue. This UDC tracks process messages which do just point processing. Allows tracking of the backlog of the Point processing queue. Note: Some messages which write to the DDS may end up on the Point Processing response queue and vice-versa. |
Analog Input |
|
|
Processing Queue Count |
SYPROCQUE |
The number of messages in the UIS processing queue (non-communications related). Examples are device and point updates. Represents the sum of SYPROCQPT and SYPROCQTX. Generally this value is best kept to less than 2. |
Analog Input |
|
|
Tx Writing Resp Queue |
SYPROCQTX |
Represents the size of the DDS transaction processing queue. This UDC tracks process messages which will save transaction data to the DDS. Allows tracking of the backlog of the DDS transaction processing queue. Note: Some messages which write to the Point Processing response queue may end up on the DDS transaction processing queue and vice-versa. |
Analog Input |
The following UDCs provide system-level information.
| UDC Description | UDC | UI Description | Description | Point Type |
|---|---|---|---|---|
|
Activate 20 Min. Stats |
SYCSST2M |
Activates the use of 20-minute statistics, which is a special rollup of one-minute values for the 20 minutes prior to execution. It helps control the strain that constant recalculation would ordinarily put on a large system. 20-minute statistics are not represented as current period-last period pairs; there is no previous statistic to compare against the current one. For each minute that passes, the rollup is recalculated with the oldest value dropped off and the most recent value added on. There is no dynamic processing of the 20-minute statistic in between the one-minute processing intervals even if the statistic's point processing is forced by the device. Activating the UDC for your UIS and selected devices does not enable mapping for the UDC. To enable mapping, you must add specific points by using the appropriate communication statistics system UDC(s) along with the required time period suffix. 20-minute statistics are applicable to communication and remote devices. For more information, see Setting Up 20-Minute Statistics. |
String Input |
|
|
Comm Device State Numeric |
SYDVST8N |
The communication device state in numeric format. Applies only to the communication device. Return values are:
|
Analog Input or Enum Input |
|
|
Comm Device State Text |
SYDVST8S |
The communication device state in string format. Applies only to the communication device. Return values are:
|
String Input |
|
|
Cryouts: Total |
SYCSCRY * |
Cryouts |
The number of total cryouts. |
Analog Input |
|
Curr Active Device |
SYCSRDVC |
The name of the currently active device. Name is displayed only when device is active; otherwise the value is blank. |
String Input |
|
|
Curr Com State Num |
SYCSSTTN * |
Specifies the state of a device communication channel. Applies to both remote devices and communication devices. The following values are possible:
If using an enumeration input point type, use the COMSTATE table for the conversions. See Failed Comm Transition Period for information about when 2 – Exception changes to 3 – Critical. For strings, see SYCSSTAT. |
Analog Input or Enum Input |
|
|
Curr Com State Text |
SYCSSTAT * |
Specifies the state of a device communication channel. Applies to both remote devices and communication devices. The following values are possible:
See Failed Comm Transition Period for information about when 2 – Exception changes to 3 – Critical. For enumerations, see SYCSSTTN. |
String Input |
|
|
Failed comm transition period |
Specifies the interval (in minutes) allowed before a communication state changes from 2 – Exception to 3 – Critical. The interval starts at the most recent failed message and extends to the previous successful message or UIS start (if no successful message exists since UIS start). The interval is not tied to current time. For example, imagine you set SYCOMSTFP to 20. A successful message occurs at 3:00:00AM and the comm state becomes Normal. Then no other message occurs until 3:10:00AM, when a failed message occurs and the comm state becomes Exception. At 3:45:00AM a second failed message occurs, which changes the comm state from Exception to Critical. That is because the Exception state was reached and more than 20 minutes passed since the last successful message. The change does not occur at 3:20:00AM or 3:40:00AM. You can apply the value to a remote device, communication device, and/or an entire UIS. If you apply this value to a remote device, the value applies to all of the remote device’s facilities. If you apply this value at the UIS level, it applies to all remote devices and communication devices in that UIS. The default value at the UIS level is 480. To change the interval for the UIS, create a point for which the facility is the applicable UIS and the UDC is SYCOMSTFP. To change the interval for a device, create a point for which the facility is the applicable device and the UDC is SYCOMSTFP. An edit to this setting does not take effect until a UIS start occurs. See Failed Comm Transition Period for information about when 2 – Exception changes to 3 – Critical. |
Analog Input |
||
|
Last Active Device |
SYCSRDVL |
The name of the last active device. |
String Input |
|
|
Not Ready Events |
SYCSSTNR * |
The current value of the consecutive Not Ready event counter. |
Analog Input |